home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / icon tools / iconmonger / iconmonger.doc < prev    next >
Text File  |  1996-04-07  |  5KB  |  121 lines
  1. PROGRAM: IconMonger 2.0
  2.  
  3. AUTHOR:  Todd M. Lewis                 E-MAIL: Todd_Lewis@unc.edu
  4.          2601 Piedmont Drive
  5.          Sanford, NC  27330-9437  USA
  6.  
  7. IconMonger is a CLI-only utility which manipulates various
  8. attributes of selected icons.  AmigaOS 2.04 or above is required.
  9. IconMonger can work on single icons or selected icons within a
  10. single directory or on an entire directory tree or disk.  Icons
  11. can be selected by name, image, icon type, stack size and/or
  12. default tool.  Possible changes include image, colors, stack
  13. size, default tool and/or position.
  14.  
  15.  
  16.  
  17. DISTRIBUTION
  18.  
  19. Sure, go ahead.  I didn't write these docs for myself, ya know.
  20.  
  21.  
  22. RUNNING THE PROGRAM
  23.  
  24. IconMonger can take a whole bunch of parameters.  The template is:
  25.  FROM/K,FILE,A=ALL/S,DISKS/S,DRAWERS/S,TOOLS/S,PROJECTS/S,TRASH=GARBAGE/S,
  26.  U=UNSNAPSHOT/S,R=RECOLOR/S,OI=OLDIMAGE/K,NI=NEWIMAGE/K,OT=OLDTOOL/K,
  27.  NT=NEWTOOL/K,OS=OLDSTACK/K,NS=NEWSTACK/N/K,NEWICON/K,
  28.  Q=QUIET/S,V=VERBOSE/S,T=TEST/S
  29.  
  30. The parameters fit into three groups: Selectors, Actions, and Modes.
  31.  
  32. Selectors allow user to specify what icons to operate on.  They are:
  33.  
  34.   FROM           Selects what directory to work in if not the
  35.                  current directory.
  36.  
  37.   FILE           A file name or pattern to match.  Do not include
  38.                  the ".info" part of icon file names.
  39.  
  40.   ALL            Extends file selection to subdirectories of the
  41.                  FROM or current directory.
  42.  
  43.   DISKS          Limits selection to these types of icons.  If none
  44.   DRAWERS        of these are specified, all icon types are
  45.   TOOLS          eligible.
  46.   PROJECTS
  47.   GARBAGE
  48.  
  49.   OLDIMAGE       Limits selection to icons with normal images which
  50.                  are identical to the specified icon's image.
  51.  
  52.   OLDTOOL        Limits selection to PROJECT icons with default tools
  53.                  which match this DOS pattern.  Example:
  54.                  "OLDTOOL=#?more" selects any icon with a default
  55.                  tool which ends with the letters "more".
  56.  
  57.   OLDSTACK       Limits selection to icons with a stack size parameter
  58.                  which matches the criteria specified.  OLDSTACK implies
  59.                  both TOOLS and PROJECTS.  OLDSTACK specifications
  60.                  consist of a relational prefix and some number.
  61.                  Valid relational prefixes are LT, LE, EQ, GE and GT.
  62.                  Example: "OLDSTACK LT2000" selects icons with a
  63.                  specified stack less than 2000 bytes.
  64.                  LT means Less Than, LE means Less Than or Equal To,
  65.                  EQ means Equal To, GE means Greater Than or Equal To,
  66.                  and GT means Greater Than.  Upper and lower case
  67.                  are both acceptable.
  68.  
  69. Action parameters tell the program what action to take with selected icons.
  70.  
  71.   UNSNAPSHOT     Same as the UnSnapshot menu item on Workbench.
  72.  
  73.   RECOLOR        Exchanges pens 1 and 2 (black and white).  This
  74.                  would be handy if you had a disk of icons from
  75.                  pre-2.04 days and you wanted to update their
  76.                  colors to match current conventions.
  77.  
  78.   NEWIMAGE       Changes the image of the selected icons to that
  79.                  of the icon specified with this parameter.
  80.                  Example: "IconMonger OLDIMAGE=Ugly NEWIMAGE=Pretty"
  81.                  would change all icons in the current directory
  82.                  that looked like "Ugly" to look like "Pretty".
  83.                  Both Ugly and Pretty would have to be icons in
  84.                  the current directory.
  85.  
  86.   NEWSTACK       Set the stack size of selected icons to this
  87.                  value.
  88.  
  89.   NEWICON        Simply replace the selected icons with this
  90.                  icon.
  91.  
  92. Modes determine how the program operates.
  93.  
  94.   QUIET          Produces few if any messages.
  95.  
  96.   VERBOSE        Explains what a command will do, and explains
  97.                  which criteria are not met by icons which are
  98.                  not selected.
  99.  
  100.   TEST           Goes through the whole process but doesn't
  101.                  actually write out any changes.  This lets you
  102.                  try out a command with relative safety until you
  103.                  are sure you are specifying the options you want.
  104.  
  105. EXAMPLES
  106.  
  107.   IconMonger FROM DF0: ALL UNSNAPSHOT RECOLOR
  108.      Unsnapshots and recolors all the icons on the disk in drive DF0:.
  109.  
  110.   IconMonger OLDTOOL=#?More NEWTOOL Less
  111.      Changes the default tool of all the PROJECT icons in the current
  112.      directory with a default tool that ends with "More" to "Less".
  113.  
  114.   IconMonger FROM DF0:Docs OLDTOOL #?(More|Less) NEWIMAGE Text
  115.      Changes the image of any PROJECT icon in the DF0:Docs
  116.      directory with a default tool that ends with either "more"
  117.      or "less" to the image of the icon "Text" which is in the
  118.      current directory.
  119.  
  120.  
  121.